1. Introduction Last updated: April 28th 2023

1.1 - Scope

This document provides an overview of the CMP 8.11 release with specific focus on the additional functional and non-functional enhancements with respect to CMP 8.10.

1.2 Audience

This document is aimed at internal and external audiences familiar with CMP, to explain the key features of the release including any changes in how existing functions or processes are working.

2 - Overview of Changes

With respect to CMP 8.10, CMP 8.11 introduces changes to existing functionality and non-functional improvements. These changes can be summarised as follows:

2.1 - Changed Functionality

2.1.1. AgentView Changes

2.1.1.1. Subscription Search

A new search facility has been provided in CMP 8.11 to allow subscriptions to be search for based on the customer identity registered in CMP. The changes are detailed in section 3.1.2.1 below.


2.2.2 - Web Services Changes

2.1.2.1. RESTful Web Services

The following new REST web services have been added in CMP 8.11:

  • Update account
  • Add direct debit
  • Cancel direct debit
  • Get an account email address
  • Update an account email address
  • Get registered cards
  • Update a registered card
  • Cancel a registered card
  • Add a service
  • Update a service
  • Update an agreement
  • Update address details
  • Activate a subscription
  • Update a subscription
  • Add subscription attributes
  • Update subscription attributes
  • Add a service
  • Update a service
  • Get compatible price plans
  • Get compatible packages
  • Change price plan
  • change serial numbers
  • Disconnect a subscription
  • Cancel a pending disconnection
  • Get termination fees
  • Get subscription email address
  • Update a subscription email address
  • Verify a one-time password
  • Generate a one-time password
  • Create a workflow

The details of these changes and other RESTful web service changes are detailed in section 3.7 below.

3 - Impacts on CMP

The functional and non-functional changes highlighted in section 2 above have had an impact CMP in the following areas:

3.1. AgentView

3.1.1. New Screens

No new AgentView screens have been introduced in the CMP 8.11 release.


3.1.2. Changed Screens

3.1.2.1. Subscription Search

In CMP 8.11, the search screen has been enhanced to allow a search for subscriptions based on a subscriber's identity. By selecting a search criteria of 'ID Type' for a subscription, the user can then select a type of identifier and enter a specific value. If there are multiple subscriptions with the same identifier then these will be displayed in the bottom panel for the user to select a record.

Subscription Search

3.2. Bulk Actions

3.2.1. New Bulk Actions

CMP 8.11 does not provide any new Bulk Actions.


3.2.2. Changed Bulk Actions

3.2.2.1. Bulk Sales Ledger Adjustments

The Bulk Sales Ledger Adjustments job has been enhanced to optionally allow a service code to be specified for individual records rather than the same service code being used for all records in the input file. If a service code is not specified for a record in the input file then the default service code (defined as a property of the sabre-manage-sales-ledger-adjustment module) will be used.

3.3. Admin Console

3.3.1. Daily Operations

3.3.1.1. New Jobs and Daemons

No new jobs have been introduced as part of the CMP 8.11 release.

3.3.1.2. Changed Jobs and Daemons

Order Request Daemon

In CMP 8.11, the Order Request daemon has been enhanced to take subscription orders into consideration. With subscription orders, it is sometimes necessary to send serial numbers to a warehouse as the warehouse may use these as part of a SIM selection process for example.

This change has necessitated a change to the order request JSON schema to include the serial number. The version of the schema has been updated to v1.2

Order Dispatch Job

In CMP 8.11, the Order Dispatch job has been enhanced to now generate an end user communication if an order has been dispatched successfully. Generation of the communications requires additional configuration as defined in section 6.5.2.1 below.


3.3.2. System Management

No changes have been made to any of the options within the System Management menu option in CMP 8.11.


3.3.3. System Monitoring

Job Executions Screen

In CMP 8.11 the Job Executions screen, accessible by clicking on the 'Executions' sub-menu item within the 'System Monitoring' menu option, has been enhanced to include a duration column to show the total duration of the last execution of the job.

Job Executions

3.3.4. System Configuration

No changes have been made to any of the options within the System Configuration menu option in CMP 8.11 .


3.3.5. System Administration

No changes have been made to any of the options within the System Administrator menu option in CMP 8.11 .

3.4. Business Configuration

3.4.1. New Business Configuration Screens

No new Business Configuration screens have been introduced as part of the CMP 8.11 release.


3.4.2. Changed Business Configuration Screens

No Business Configuration screens have been changed as part of the CMP 8.11 release.

3.5. Pricing Configuration

3.5.1. New Pricing Configuration Screens

There are no new Pricing Configuration screens that have been introduced as part of CMP 8.11.


3.5.2. Changed Pricing Configuration Screens

No Pricing Configuration screens have been changed as part of CMP 8.11.

3.6. SOAP Web Services

3.6.1. New Web Services

No new SOAP web services have been introduced as part of the CMP 8.11 release.


3.6.2. Changed Web Services

No SOAP web services have been changed as part of the CMP 8.11 release.

3.7. RESTful Web services

3.7.1. New CMP Web Services

3.7.1.1. Activate Subscription Web Service

To support a two-phase subscription sign-up and registration process whereby a sign-up for mobile service and the activation of the subscription following registration occur at different times, a new API is provided that allows a pre-created subscription to be completed in CMP and provisioned on the network.

3.7.1.2. Subscription Web Services

A new Update Subscription web service has been added to allow certain details for a subscription to be updated, namely user name , password, date of birth, gender, marital status and cost centre.

A new Disconnect Subscription web service has been added to allow a subscription to be disconnected from an external system. The disconnection can be immediate or scheduled for a future date. A Cancel Disconnection web service has also been added to enable a pending disconnection for a subscription to be cancelled. Typically, this web service would be used where there is a future disconnection pending and the subscription has changed their mind.

In order to support the retrieval of any charges a subscriber would be liable for prior to disconnection, a new Get Termination Fees web service has been added to return the termination fees a subscription would have to pay based on what date they wish to terminate on.

3.7.1.2.1 Subscription Services

An Add Subscription Service web service has been added that adds a one-off or recurring service to a subscription. An Update Subscription Service has also been added to expire a recurring service on a subscription. Note, the service to be expired cannot be part of a package.

3.7.1.2.2 Subscription Attributes

A Create Subscription Attribute web service has been added that allows a subscription attribute to be created against the subscription and a value set for it. An Update Subscription Attribute has also been added to allow subscription attribute values to be updated.

3.7.1.2.3 Subscription Email Addresses

A Get Subscription Email Addresses web service has been added that retrieves all email addresses registered against the subscription. An Update Subscription Email Address web service has also been added to update the email address registered against the subscription.

3.7.1.3 Change Price Plan

A new web service, Change Price Plan has been added to allow the current price plan on a subscription to be changed to another compatible price plan. The price plan change can be scheduled immediately or at some future date. A price plan change is not possible if the subscription is disconnected or if the subscription is part of an agreement price plan. A plan change is also prevented if the associated agreement has had its bill cycle changed and is not yet on the new bill cycle. Where the subscription has an active contract then the price plan change cannot take effect on or before the end of the early upgrade period or before the notice period ends.

3.7.1.4 Change Serial Numbers

A new web service, Change Serial Numbers has been added to change a subscription's managed and non-managed serial numbers. An array of managed and non-managed serial numbers can be provided as part of the request.

3.7.1.5. Account Email Addresses Web Services

A Get Account Email Addresses web service has been added that retrieves all email addresses registered against an account. An Update Account Email Address web service has also been added to update the email address registered against the account.

3.7.1.6. Direct Debit Web Services

Three new web services have been created to support the creation and management of direct debits:

  • Add Direct Debit Details - POST request to add new direct debit details to the account or change existing direct debit details. New direct debit details can only be added to accounts that have a manual payment method. If the account has an existing direct debit then cancellation details are required for the existing direct debit before a new one can be added
  • Cancel a Direct Debit - POST request to cancel the direct debit payment method on the account. The account will be automatically put on a manual payment method.

3.7.1.7. Registered Card Web Services

Three new web services have been created to support the query and management of registered cards held against an account:

  • Get Registered Cards - GET request to retrieve all cards registered against an account
  • Update Registered Card - PATCH request to associate a credit/debit card registered against an account with a subscription on that account
  • Cancel Registered Card - POST request to cancel a credit/debit card registered against an account.

3.7.1.8 One-time Password

Two new web services have been added to support the generation, and subsequent verification, of a one-time password that can be sent to a subscriber to validate an action through an external system such as a mobile app.

The Generate One-time Password web service allows a one-time password (OTP) to be generated for a subscription or an account and for that password to be issued via an SMS or push notification for example. The Verify One-time Password web service allows an OTP, entered by an end user, to be verified against the OTP sent to them.

3.7.1.9. Agreement Web Services

A new web service, Update Agreement has been added to update an agreement's bill cycle and/or billing media. Updating the bill cycle forces a bill cycle change on the agreement.

3.7.1.10. Contact Details Web Service

A new web service, Update Contact Details has been added to allow contact and address details to be updated. The web service supports update of personal details, business details, address details and contact details. Validation is provided to ensure contact and address details cannot be erased.

3.7.1.11. Compatible Products Web Services

New web services have been added to allow compatible price plans and compatible packages to be returned for a specific subscription. The Get Compatible Price Plans web service provides a list of price plans that a subscriber can change to based on the current price plan they are on. The Get Compatible Packages web service provides a list of one-off and recurring bolt-ons that a subscriber can subscribe to based on the current price plan they are on or that they are changing to.

3.7.1.12. Workflow Web Service

A new Create Workflow web service has been added to support the creation of a workflow event against a CMP hierarchical entity.


3.7.2. Changed CMP Web Services

3.7.2.1. Subscription Web Services

The GET Subscriptions and GET Subscription web services have been updated to return the base package details of the subscription. In addition, the GET Subscriptions web service has been update to support additional query parameters (filters). It is now possible to query for subscriptions based on a specific non-managed serial number value and also by the identity type and value held against a subscription. The meta data of the response object has been updated to show the number of subscriptions returned in the response (recordCount) and of those, the number that are currently active in CMP (activeRecordCount).

3.7.2.2. Subscription Spend Cap Web Service

The response object of the GET Subscription Spend Cap web Service has been modified to include the type of cap (Partial or full).

3.7.2.3. Allowance Web Service

The Get Allowances web service has been modified to add the purchase identifier to the response object. This allows the distinction to be made between bolt-on and base packages (base packages don't have a purchase identifier associated with them).

3.7.2.4. Account Web Services

The response object of the Get Account web service has been updated to return the mandate received date and direct debit setup method code within the bankPayment container for direct debit customers.

3.7.2.5. Registered Card Web Service

The GET Registered Card web service has been updated as follows:

  • The accountNumber element in the request body has been deprecated as the accountId path variable is used instead for the request
  • The response object has been updated to return details of the card that has been created against account.

3.7.3. New Business Configuration Web Services

3.7.3.1. Network Web Services

No new RESTful web services have been introduced in CMP 8.11.


3.7.4. Changed Business Configuration Web Services

No RESTful web services have been updated as part of the CMP 8.11 release.

3.8. Integration Adapters

No changes have been made to integration adapters in CMP 8.11.

3.9. NetEngage Adapters

The NetEngage-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.

3.9.1. Provisioning Adapter

When CMP is being used in conjunction with the NetEngage OCS, subscribers created in CMP and requiring real-time control of their usage need to be provisioned to the NetEngage OCS along with any allowances purchased as part of the registration process and any spend caps automatically assigned.

Connecting a new subscription on the NetEngage OCS is a two-step process; an initial creation of a pre-active subscription followed by a request to activate it. Both of these steps must succeed in order for the subscription to be connected correctly on the OCS and subsequently in CMP. In CMP 8.11 the two-step provisioning process has been enhanced to support the re-connect process in the case where the first step has succeeded but the second step has failed because a pre-active subscription already exists for example. In this case, an event is generated in CMP to retry the second step of the connection to allow any allowances and spend caps to be added.

3.10. Openet Adapter

The Openet-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.

No changes have been made to the Openet adapter as part of CMP 8.11.

3.11. Lifecycle Adapter

The Lifecycle-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.

No changes have been made to the Lifecycle adapter as part of CMP 8.11.

3.12. UK-specific Adapters

No changes have been made to UK-specific adapters in CMP 8.11.

4 - Product Fixes

In addition to functional and non-functional changes and improvements, the CMP 8.11 product also addresses a number of application support issues. This section provides a summary of the issues fixed in this release.

The following issues have been addressed within this release:

Reference Area Description
CMPIS-2578Web ServicesREST - GET Compatible Packages returns inactive packages
CMPIS-2575NetEngage - Provisioning AdapterThe NetEngage Adaptor did not correctly support unlimited allowances
CMPIS-2573Admin ConsoleA pause button was displayed for the next job in a process rather than a play button
CMPIS-2570Admin ConsoleConsole - View Logs - Blinking Dots
CMPIS-2568Invoice ProductionBilling - Database connections not released
CMPIS-2567NetEngage - Provisioning AdapterEncrypted Password in NetEngage Adaptor
CMPIS-2552Invoice ProductionInvoice Production - Connection Refused Error
CMPIS-2541Admin ConsoleConsole - System Configuration - Logging - Discard Partition
CMPIS-2540Web ServicesSOAP - Update Subscription Serial Numbers - SIM Pairing Error
CMPIS-2539CommsTriggered Job stuck & no further comms can be processed
CMPIS-2538Admin ConsoleConsole - Schedule - Suspend/Resume Not Working
CMPIS-2537Admin ConsoleConsole - Interface Batch List Sort & Refresh Issues
CMPIS-2536Admin ConsoleConsole - Scheduler Issues - Multiple Sabre Instances
CMPIS-2535Batch JobsSabre Batch - Job Execution Race Condition
CMPIS-2531Advance NotificationAdvance Notification - Subs with active recurring bolt ons incorrectly receiving notifications
CMPIS-2522Web ServicesREST - Update Email Address - Duplicate error handling
CMPIS-2519Invoice ProductionInvoice Production - Non null constraint on Account NEID
CMPIS-2517Web ServicesREST - Creation of Failed Payment gives null pointer exception
CMPIS-2513Batch JobsVarious Batch Jobs - Errors creating Interface Batch Detail Partitions
CMPIS-2512Web ServicesREST - Get Subscription - Not Returning Bar information
CMPIS-2509Usage ArchivingUsage Archiving - Lock Issue in Production
CMPIS-2508Web ServicesREST - Get Properties - Filters not working
CMPIS-2502Allocation MonitorAllocation Monitor crashes when no DiaryEventProperties for add & end package event
CMPIS-2495Web Services REST - Successful Enable and Disable Feature response is empty
CMPIS-2413Web ServicesREST - Web Services Not Working in Highly Available mode
CMPIS-2360Business ConfigurationConfig Centre - Add Service - Pro ration Flags Set Incorrectly
CMPIS-2183Openet Provisioning AdaptersProvisioning - Failed Purchases Not Recorded
CMPIS-1980Admin ConsoleConsole - Interface Batch Load - Performance
CMPIS-353CommsComms - Templates Location Changes Required

5 - Documentation

5.1 - Product Documentation

The product documentation is available online on the documentation portal. This online portal requires authorised access, which can be obtained by contacting MDS Global support. The documentation is also available as downloadable PDFs as follows:

  • Installation Guide
  • Technical Architecture
  • CMP Overview
  • Documentation Overview
  • System Administration Guide
  • Security Guide
  • AgentView Function Security Guide
  • Operational Overview
  • Business Configuration Overview
  • Billing Functionality Guide
  • Communications Functionality and Configuration Guide
  • Payments Functionality Guide
  • Extracts Guide
  • Purge Guide
  • Standard Reporting
  • Batch Jobs and JSON Schemas Guide
  • RESTFul Web Services API Guide
  • SOAP Web Services Semantics Guide
  • Business Configuration RESTFul Web Services API Guide

5.2 - Online Documentation

Online help is available in AgentView, Business Configuration, the Administration Console and the Bulk Actions console.

6 - Release Upgrade

The CMP 8.11 installer includes the capability to upgrade a CMP 8.10 installation without the loss of configuration or customer data provided that the software, file system and database structure of the installation in question are at no point manually modified.

Important

The CMP 8.11 Installation Guide, and the details below, should be read before attempting the upgrade to CMP 8.11.

It is important that the following sections are read prior to performing the upgrade, specifically the Configuration Changes section, as it may be advisable to backup relevant configuration prior to performing the upgrade to ensure the configuration can be replicated, if necessary, post upgrade.

6.1. Upgrade Notes

Important

It is important that the existing installation is left running before starting the upgrade. There is no reason to shut down any components however service may be affected whilst performing the upgrade.

6.2. Installation Configuration Tool Changes

No changes have been made to the Installation Configuration Tool as part of CMP 8.11.

6.3. Third party libraries

The CMP 8.11 release supports deployment on community enterprise versions of Red Hat Enterprise Linux (Rocky Linux), JBoss Enterpise Application Platform (Wildfly v26.1.3) and JBoss Web Server (Tomcat v 9.0.73).

6.4. Database Changes

6.4.1. New Tables and Views

The following table has been added in CMP 8.11:

  • orderDispatchSerialNumberBatchDetail - Table that facilitates the scenario where a warehouse is supplying serial numbers as part of the order dispatch process.

In addition, the 'orderDispatchBatchDetailLine' table has been renamed to 'orderDispatchLineBatchDetail' and the 'orderDispatchBatchDetailLineAttribute' table has been renamed to 'orderDispatchLineAttributeBatchDetail'.

The following views have been added to the database schema in CMP 8.11:

  • accountComment - View over table CRS3REP
  • bankHeader - View over table CODNREP
  • creditCardDebitCardDetailHistory - View over table COG9REP
  • directDebitSetupMethod - View over table CUD2REP excluding explanation text 1,2,3 and 4 columns
  • oneoffPassword - View over table C4B2CPP (Diary Event Alias)
  • oneoffPasswordCode - View over table C4B1REP (Diary Event Code Alias)
  • packageGroupMember - View over table CVB5REP
  • subscriptionAttributeHistiry - View over table CHBHREP
  • termsAndConditionsGroup - View over table COHRREP

6.4.2. New Attributes

The following table attributes have been added in CMP 8.11:

  • Table product (CSN0REP), attributes dispatchEventType and dispatchEventCode

6.4.3. Dropped Tables and Views

No tables or views have been dropped in CMP 8.11.


6.4.4. Dropped Attributes

No table attributes have been dropped in CMP 8.11.


6.4.5. Modified Attributes

No table attributes have been modified in CMP 8.11.

6.5. Configuration Changes

6.5.1. Module Configuration Updates

As part of a review of the trigger delay timeout settings currently pre-configured as part of a new installation, the timeout values for the following trigger jobs and daemons have been updated from a trigger timeout of 3 seconds to the values specified below. These values will be automatically applied as part of the 8.11 upgrade:

Module NameJob/DaemonNew Timeout (s)
sabre-allocationsJob3
sabre-bill-pdf-collection-adapterTransformation daemon1800
sabre-bill-printExtract daemon180
sabre-bill-printTransmission daemon180
sabre-bulk-action-frameworkJob1800
sabre-bulk-action-frameworkTransformation daemons1800
sabre-bulk-action-frameworkTransmission daemons1800
sabre-commsExtract daemons3
sabre-commsJob3
sabre-commsLoad daemons3
sabre-commsTransmission daemons3
sabre-credit-controlExtract Daemon1800
sabre-credit-referenceExtract Daemon1800
sabre-data-warehouseTransmission daemon1800
sabre-edit-subscriptionJob1800
sabre-edit-subscriptionLoad daemon1800
sabre-general-ledgerExtract daemon1800
sabre-generic-postingout-daemonExtract Daemon180
sabre-invoice-postingExtract daemon180
sabre-invoice-postingTransmission daemon180
sabre-managed-numbersJob1800
sabre-managed-numbersLoad daemon1800
sabre-manage-plan-tariff-changeJob1800
sabre-manage-plan-tariff-changeLoad daemon1800
sabre-manage-sales-ledger-adjustmentJob1800
sabre-manage-sales-ledger-adjustmentLoad daemon1800
sabre-manage-subscription-contractJob1800
sabre-manage-subscription-contractLoad daemon1800
sabre-manage-subscription-featureJob1800
sabre-manage-subscription-featureLoad daemon1800
sabre-manage-subscription-serviceJob1800
sabre-manage-subscription-serviceLoad daemon1800
sabre-manage-workflowJob1800
sabre-manage-workflowLoad daemon1800
sabre-mandate-registrationsExtract daemon1800
sabre-mandate-revisionsJob1800
sabre-mandate-revisionsLoad daemon1800
sabre-mdsledger-adapterTransmission daemons180
sabre-non-recurring-paymentsJob1800
sabre-non-recurring-paymentsLoad daemon1800
sabre-rated-usageJob3
sabre-rated-usageLoad daemon3
sabre-receipt-pdf-collection-adapterTransformation daemon1800
sabre-receipt-printExtract daemon1800
sabre-recurring-paymentsExtract daemons1800
sabre-recurring-paymentsLoad daemons1800
sabre-recurring-paymentsRejections Job1800
sabre-recurring-pre-paymentsExtract daemons1800
sabre-recurring-pre-paymentsLoad daemons1800
sabre-recurring-pre-paymentsRejections Job1800
sabre-sim-profileJob1800
sabre-sim-profileLoad daemon1800
sabre-termination-fee-monitorJob60
sabre-wholesale-usageLoad daemon180
sabre-wholesale-usage-adapterLoad daemon180

6.5.2. Manual Configuration

6.5.2.1. Network Table

It should be verified that any of the S1/2/3/4/5 or P1/2/3/4/5/6/7/8/9 description and short decsription fields on the Network table that are currently populate with a blank should be replaced with a null.


6.5.3. Standard Data Population

As part of CMP 8.11, the standard data population scripts used to auto-populate a number of CMP configuration tables for a greenfield installation have been updated. For existing installations, the configuration specified in this section will be automatically injected into the appropriate database table and therefore will not need to be manually configured.

6.5.3.1. Workflow Properties

The following workflow properties will be added as part of the upgrade to CMP 8.11:

Order Dispatch Communication

The following configuration is required to support the generation of an order dispatch communication as part of the end to end orders process:

Property GroupProperty NameEvent TypeEvent Code
SALESORDERorder.dispatch.successSOPDISS

The workflow SOP/DISS has also been added to the workflow event type (COBXREP) and event code (COCQREP and CVDDREP) tables.

Note

Although the Workflow Properties and Workflow tables are populated as part of the CMP 8.11 upgrade, a comms code for a successful order dispatch also needs to be created through Business Configuration and linked to the workflow event defined for the order.dispatch.success workflow property.

One-time Password

The following configuration is required to support the generation of a one-time password for a subscription or account:

Property GroupProperty NameEvent TypeEvent Code
COMMSone.time.passwordCOMMOTP

The workflow COMM/OTP has also been added to the workflow event type (COBXREP) and event code (COCQREP and CVDDREP) tables.

Note

Although the Workflow Properties and Workflow tables are populated as part of the CMP 8.11 upgrade, a comms code for the one-time password communication also needs to be created through Business Configuration and linked to the workflow event defined for the one.time.password workflow property.